home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / prgtools / langs / f68k.zoo / ql / qlf68k.txt < prev   
Encoding:
Text File  |  1991-08-06  |  7.6 KB  |  188 lines
  1. ◆**************************************************
  2. ***                                            ***
  3. ***                Loader for                  ***
  4. ***                ^^^^^^^^^^                  ***
  5. ***                   F68K                     ***
  6. ***                   ^^^^                     ***
  7. ***                  on the                    ***
  8. ***                Sinclair QL                 ***
  9. ***                                            ***
  10. ***              by Dirk Kutscher              ***
  11. ***                                            ***         
  12. **************************************************
  13.  
  14. Content
  15.          Hardware Requirements
  16.          Files
  17.          Getting started
  18.          Special features
  19.          Problems?
  20.          Remark
  21.  
  22.  
  23. *************************
  24. * Hardware Requirements *
  25. *************************
  26.  
  27. To start  F68K on your QL you need at  least one 3.5" disc drive and a
  28. minimum of 256 KB RAM. If you lack the disc drive you might be able to
  29. run F68K but should not try  to  use  the  Streaminterface  to  access
  30. DEVICE1_SCR since it is assumed to provide 300 blocks which you cannot
  31. emulate on microdrive. I am working at a mdv version at the moment.
  32.  
  33.  
  34. ************
  35. *  FILES   *
  36. ************
  37.  
  38. The loader consists of the following files:
  39.  
  40. bootF68K_QL   This  is  a  SuperBASIC-program  which  initialises  the
  41.               F68K-Disc for the use  on  a  QL-System.  If  your  F68K
  42.               version was distributed on Atari Disc it is necessary to
  43.               recreate  the QLF68K_exe file  (as well as QLCONFIG_exe)
  44.               since  the job  information in  the  header  of QL-files
  45.               (Dataspace etc.)  is not available on Atari  Discs. Once
  46.               you have run  this program  on  your  QL  Disc  you  can
  47.               happily forget it.
  48.  
  49. QLF68K_EXE    This  the EXECutable loader created  by boot. Start F68K
  50.               by  typing  'EXEC flp1_QLF68K_EXE'.  Of  course  you can
  51.               also use QRAM etc..
  52.  
  53. QLF68K_CDE    This  is the machinecode  program for  loading F68K.  If
  54.               you have the  -exe file installed it  should not concern
  55.               you anymore.
  56.  
  57. QLF68K_ASM    This is  the assembler  source for  the loader.  It will
  58.               probably  only assemble on Talent's Workbench Assembler,
  59.               but it might  give you some  ideas of how  to write your
  60.               own loaders.  (Of course you  may also use  it to expand
  61.               the loader).
  62.  
  63. QLF68K_TXT    this one
  64.  
  65. CHANGES_TXT   loader development documentation
  66.  
  67. QLCONFIG_exe  This is the configuration  utility  for  QLF68K_exe.  It
  68.               gives  you   the  possiblity  to   patch  the  following
  69.               filenames    according   to   your   personal   hardware
  70.               environment:
  71.                    
  72.                    flp1_F68K_img       (the F68K bit image)
  73.                    flp1_F68K_out       (the F68K output file)
  74.                    flp1_F68K_in        (the F68K input file)
  75.                    flp1_DEVICE1_scr    (Blockdevice for RW-access)
  76.                    flp1_STREAMS_scr              ""
  77.                    ser1                (Printer device)
  78.               
  79.               If you like to keep these names you just have to confirm
  80.               by hitting ENTER. You are then asked (in German), if you
  81.               would  like these names  (except for the  printer) to be
  82.               questioned  again when  starting F68K.  For experiments,
  83.               first attempts  etc. it  might be  useful to  answer 'j'
  84.               (for  'yes'). If you are familar with the system or even
  85.               want  save a  complete application  'n' (for  'No') will
  86.               make the loader start F68K directly when executed.
  87.  
  88. QLCONFIG_cde  The mc-file for the  configuration  utility.  Loaded  by
  89.               bootF68K_QL.
  90.  
  91.  
  92. *******************
  93. * Getting started *
  94. *******************
  95.  
  96. On executing  QLF68K_exe the  program first  tries to  allocate enough
  97. space in  the memory  for F68K.   If the  neccessary amount   of bytes
  98. ($10000  +  $20028  for  code  and  data)   is   not   available   the
  99. execution will terminate.
  100.  
  101. After this  the  program   opens  the   console  and  gives   you  the
  102. possibility to change the   names  for   the  necessary   files.  (See
  103. files.QLConfig_exe) If   you do  change the  names (e.g.   the device)
  104. you should  make  sure  that these  files  really exist  and that they
  105. also can  be accessed in the same way  as  the original file names. If
  106. no change is necessary just confirm by hitting ENTER.
  107.  
  108. Now   the program is  loading the F68K-file  (i.e 'flp1_F68K_IMG'). If
  109. loading   has  been  succesful   F68K  should  now   prompt  with  the
  110. copyright note and with it's 'ok'.
  111.  
  112. If  you want to access  the Blockdevice now you  should make sure that
  113. you can provide the specified files (e.g. DEVICE1_SCR and STREAMS_SCR)
  114. on the specified devices  otherwise you  might at  least get  an error
  115. report by QDOS or F68K.  You  do  not  have  to  worry  about  closing
  116. channels when changing discs (e.g. on a multitasking QL), since the RW
  117. routines are somewhat  'atomic' in  this regard:  They open  and close
  118. their  channels each time they are called. At first this seems to slow
  119. down the  block accesses but  thanks to QDOS  this impression vanishes
  120. because all the often called directory blocks etc. are stored in slave
  121. blocks of the QDOS filing system.
  122.  
  123.  
  124. ********************
  125. * Special features *
  126. ********************
  127.  
  128. Since F68K's  editor uses   VT52-sequences  to   control  the   cursor
  129. etc., which  is normally  non-standard  on   the  QL,   these  control
  130. codes are  emulated by the  loader's I/O   routines. There  is also  a
  131. translation table for some  special  characters  ("Deutsche  Umlaute")
  132. including ENTER, BACKSPACE etc.
  133.  
  134. Nevertheless the user may  still redirect  I/O as  he desires.  I have
  135. provided  three different EMIT routines each giving a different degree
  136. of emulation: Default is full emulation. The VT52-sequences as well as
  137. the  the translation tables  are supported. You  could  switch between
  138. these  different modes by  some simple FORTH words:
  139.               
  140.               : VT52_OFF ( -- ) EMITS 8 + @ ^EMIT ! ;
  141.  
  142.               : VT52_ON  ( -- ) EMITS 4 + @ ^EMIT ! ;
  143.  
  144.               : NO_TRANSLATION ( -- ) EMITS 12 + @ ^EMIT ! ;
  145.  
  146.  
  147. *************
  148. * Problems? *
  149. *************
  150.  
  151. Problems may occur if you have got the TOS-formatted F68K disc and are
  152. not  able to create the appropriate QL disc, probably because you lack
  153. a disc driver or a transformation utility. In such a case you can send
  154. me (adress below)  two  QDOS-formatted  3.5"  discs  AND  a  paid  and
  155. self-adressed envelope and  I will rush  you the latest  QL version as
  156. soon as possible.
  157.  
  158.  
  159. **********
  160. * Remark *
  161. **********
  162.  
  163. I have  written  this  loader  to  support  both  the  spread  of  the
  164. programming  language Forth and QDOS, the  operating system of the QL.
  165. So you can make as  many copies  of the  loader as  you want  and also
  166. distribute  them as long as no profit is gained by the distribution. I
  167. would also like my name to be kept visible etc...
  168.  
  169. The  programme  has   been  successfully   tested  on   R.  Kowallik's
  170. QL-Emulator for the Amiga.
  171.  
  172. I have no objections to somebody writing a C version of the loader nor
  173. other improvements. I would be pleased to hear from you then!
  174.  
  175. For suggestions, questions  or  any  other  comments  please  use  the
  176. following adress:
  177.  
  178.          Dirk Kutscher
  179.          Kastanienweg 39
  180.          2804 Lilienthal
  181.          Germany
  182.  
  183. You can also contact me via eMail using one of the following adresses:
  184.  
  185. Dirk_Kutscher@HB.MAUS.DE
  186.  
  187. Karl @ BBS.FORTH-eV.de
  188. ◆
  189.